Namespaces

Types in MathNet.Numerics.LinearAlgebra.Solvers

Type DivergenceStopCriterion<T>

Namespace MathNet.Numerics.LinearAlgebra.Solvers

Interfaces IIterationStopCriterion<T>

Monitors an iterative calculation for signs of divergence.

Constructors

Methods

Properties

Public Constructors

DivergenceStopCriterion<T>(double maximumRelativeIncrease, int minimumIterations)

Initializes a new instance of the DivergenceStopCriterion<T> class with the specified maximum relative increase and the specified minimum number of tracking iterations.
Parameters
double maximumRelativeIncrease

The maximum relative increase that the residual may experience before a divergence warning is issued.

int minimumIterations

The minimum number of iterations over which the residual must grow before a divergence warning is issued.

Public Methods

IIterationStopCriterion<T> Clone()

Clones the current DivergenceStopCriterion<T> and its settings.
Return
IIterationStopCriterion<T>

A new instance of the DivergenceStopCriterion`1 class.

IterationStatus DetermineStatus(int iterationNumber, Vector<T> solutionVector, Vector<T> sourceVector, Vector<T> residualVector)

Determines the status of the iterative calculation based on the stop criteria stored by the current IIterationStopCriterion<T>. Result is set into Status field.
The individual stop criteria may internally track the progress of the calculation based on the invocation of this method. Therefore this method should only be called if the calculation has moved forwards at least one step.
Parameters
int iterationNumber

The number of iterations that have passed so far.

Vector<T> solutionVector

The vector containing the current solution values.

Vector<T> sourceVector

The right hand side vector.

Vector<T> residualVector

The vector containing the current residual vectors.

bool Equals(object obj)

int GetHashCode()

Type GetType()

void Reset()

Resets the IIterationStopCriterion<T> to the pre-calculation state.

string ToString()

Public Properties

double MaximumRelativeIncrease get; set;

Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.

int MinimumNumberOfIterations get; set;

Gets or sets the minimum number of iterations over which the residual must grow before issuing a divergence warning.

IterationStatus Status get;

Gets the current calculation status.